// Copyright 2013 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.enterprise.connector.otex;

import com.google.enterprise.connector.spi.RepositoryException;

/**
 * An optional extension of {@link ContentHandler} that is notified on
 * every batch in order to refresh internal state as needed.
 *
 * @since 3.2.2
 */
interface RefreshableContentHandler extends ContentHandler {
  /**
   * Refreshes the content handler. This method must be thread-safe.
   * This method will be called at least once per call to
   * {@link TraversalManager#startTraversal} or
   * {@link TraversalManager#resumeTraversal} and may be called
   * simultaneously from multiple threads.
   */
  void refresh() throws RepositoryException;
}
